Skip to content

rustdoc: Don't use CURRENT_DEPTH in clean/types.rs #82745

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

rustdoc: Don't use CURRENT_DEPTH in clean/types.rs #82745

wants to merge 1 commit into from

Conversation

camelid
Copy link
Member

@camelid camelid commented Mar 4, 2021 •
edited
Loading

Helps with #82742.

This part actually wasn't that hard. Ending the use of it in
html/format.rs is probably going to be a lot harder.

r? @jyn514

@camelid
rustdoc: Don't use CURRENT_DEPTH in clean/types.rs
fa3ad97 
This part actually wasn't that hard. Ending the use of it in
`html/format.rs` is probably going to be *a lot* harder.
@camelid camelid added C-cleanup Category: PRs that clean code up or issues documenting cleanup. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Mar 4, 2021
@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Mar 4, 2021
camelid
camelid commented Mar 4, 2021
View reviewed changes
src/librustdoc/html/render/mod.rs
@@ -170,6 +170,10 @@ crate struct SharedContext<'tcx> {
}

impl<'tcx> Context<'tcx> {
fn depth(&self) -> usize {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can add docs here if you like. Let me know what you think.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, that seems useful.

@rust-log-analyzer
Copy link
Collaborator

The job mingw-check failed! Check out the build log: (web) (plain)

Click to see the possible cause of the failure (guessed by this bot) 
Removing intermediate container 83b0f72e453a
 ---> 8292d051df8a
Step 5/10 : RUN npm install es-check -g
 ---> Running in 4ad8010d6ef9
/node-v14.4.0-linux-x64/bin/es-check -> /node-v14.4.0-linux-x64/lib/node_modules/es-check/index.js

> spawn-sync@1.0.15 postinstall /node-v14.4.0-linux-x64/lib/node_modules/es-check/node_modules/spawn-sync
> node postinstall
+ es-check@5.2.1
added 95 packages from 44 contributors in 3.581s
Removing intermediate container 4ad8010d6ef9
 ---> 9467df7855a6
---
Successfully built 3c46b266ec56
Successfully tagged rust-ci:latest
Built container sha256:3c46b266ec56879acdb2ea9d25d9fd202558a86f7a01a4442537fe8ff0aa3d18
Uploading finished image to https://ci-caches.rust-lang.org/docker/9f2a38e35a8211f9c2c342213b6dabbf1ce1e957c3f9f4a6874af054aa93d446d1c6f8252277cb4118d76ddf7862eec7c972b385df9acf97d8b518b20c0181e6
upload failed: - to s3://rust-lang-ci-sccache2/docker/9f2a38e35a8211f9c2c342213b6dabbf1ce1e957c3f9f4a6874af054aa93d446d1c6f8252277cb4118d76ddf7862eec7c972b385df9acf97d8b518b20c0181e6 Unable to locate credentials
[CI_JOB_NAME=mingw-check]
---
configure: rust.channel         := nightly
configure: rust.debug-assertions := True
configure: llvm.assertions      := True
configure: dist.missing-tools   := True
configure: build.configure-args := ['--enable-sccache', '--disable-manage-submodu ...
configure: writing `config.toml` in current directory
configure: 
configure: run `python /checkout/x.py --help`
configure: 
---
skip untracked path cpu-usage.csv during rustfmt invocations
skip untracked path src/doc/book/ during rustfmt invocations
skip untracked path src/doc/rust-by-example/ during rustfmt invocations
skip untracked path src/llvm-project/ during rustfmt invocations
Diff in /checkout/src/librustdoc/clean/types.rs at line 869:
                     None => {
                         if let Some(ref fragment) = *fragment {
                             let url = match cache.extern_locations.get(krate) {
-                                Some(&(_, _, ExternalLocation::Local)) => {
-                                    "../".repeat(depth)
-                                }
+                                Some(&(_, _, ExternalLocation::Local)) => "../".repeat(depth),
                                 Some(&(_, _, ExternalLocation::Remote(ref s))) => s.to_string(),
                                 Some(&(_, _, ExternalLocation::Unknown)) | None => String::from(
                                     // NOTE: intentionally doesn't pass crate name to avoid having
Running `"/checkout/obj/build/x86_64-unknown-linux-gnu/stage0/bin/rustfmt" "--config-path" "/checkout" "--edition" "2018" "--unstable-features" "--skip-children" "--check" "/checkout/src/librustdoc/clean/cfg.rs" "/checkout/src/librustdoc/doctree.rs" "/checkout/src/librustdoc/clean/simplify.rs" "/checkout/src/librustdoc/core.rs" "/checkout/src/librustdoc/clean/cfg/tests.rs" "/checkout/src/librustdoc/clean/types.rs"` failed.
If you're running `tidy`, try again with `--bless`. Or, if you just want to format code, run `./x.py fmt` instead.
Build completed unsuccessfully in 0:00:13

jyn514
jyn514 reviewed Mar 4, 2021
View reviewed changes
src/librustdoc/html/render/mod.rs
@@ -170,6 +170,10 @@ crate struct SharedContext<'tcx> {
}

impl<'tcx> Context<'tcx> {
fn depth(&self) -> usize {
self.current.len()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm confused - did current already exist? How is it kept in sync with CURRENT_DEPTH?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CURRENT_DEPTH is set to self.current.len() in render_item(). self.current should always be the same when rendering a particular item since it represents the namespace hierarchy.

Copy link
Member Author

@camelid camelid Mar 5, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can combine this PR with #82815 if you like so that we don't have to worry about keeping CURRENT_DEPTH in sync with depth().

@jyn514 jyn514 added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Mar 4, 2021
@bors
Copy link
Collaborator

bors commented Mar 4, 2021

☔ The latest upstream changes (presumably #82756) made this pull request unmergeable. Please resolve the merge conflicts.

@camelid camelid mentioned this pull request Mar 5, 2021
Closed
@jyn514
Copy link
Member

jyn514 commented Mar 5, 2021

It looks like this PR is the first commit of #82815, so I'm going to close this in favor of that PR. Thanks for working on this!

@jyn514 jyn514 closed this Mar 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
1 more reviewer

@jyn514 jyn514 jyn514 left review comments

Reviewers whose approvals may not affect merge requirements
Assignees

@jyn514 jyn514

Labels
C-cleanup Category: PRs that clean code up or issues documenting cleanup. S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@camelid @rust-log-analyzer @bors @jyn514 @rust-highfive